Documentation site - Composable for Python (mkdocs-material, engine theme) + CI workflow - #20
Merged
Merged
Conversation
…gine theme) The P4 docs chapter for the python wrapper: three-layer theme reference (index), rationale + design foundations, function-writing patterns, configuration/logging/actuators, testing, the Event Script and Knowledge Graph join chapters, a one-page AI agent guide + llms.txt (the two-audience criteria: storytelling for humans, token-efficient grammar for AI), and configuration/HTTP-surface references. Same Material theme, palette, extensions and strict validation as the engine site. New ci.yml runs the three quality gates plus the strict docs build and publishes gh-pages on main - closing the wrapper-CI gap. Co-Authored-By: Claude Code <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The P4 documentation site for the Python wrapper, plus the repo's fresh CI workflow:
mercury-composable engine repo (deep purple/cyan palettes with auto/light/dark,
navigation tabs, mermaid diagrams, strict validation, the same css/extra.css) —
publishing to https://accenture.github.io/mercury-python/
Knowledge Graph) and where a Python function joins it
wrappers, why sync and async handlers:
requests/NumPy vs asyncio)event bus, the sync bridge)
(
yaml.event.over.http; notes the graph.task declarative-target floor ofengine v4.11.11)
alone") plus
llms.txtas the machine map.github/workflows/ci.yml— the rebooted repo had no CI: quality gates(pytest, ruff, basedpyright on the python 3.10 floor) on every push/PR, a strict
docs build check, and
mkdocs gh-deployon main pushes.gitignore+site/Why
P4 of the polyglot initiative — documentation for AI and Human. Every page follows the
two-audience doctrine: storytelling with why-before-how for humans, and token-efficient
machine-greppable content for AI agents. Using the engine repo's theme verbatim keeps a
polyglot installation's documentation visually and structurally uniform across
accenture.github.io/mercury-composable, /mercury-python and /mercury-nodejs.
Gates: pytest 57/57, ruff clean, basedpyright 0 errors,
mkdocs build --strictexit 0.Post-merge: enable GitHub Pages (branch
gh-pages) after the first deploy run, andspot-check mermaid rendering on the live site.
🤖 Generated with Claude Code
Co-Authored-By: Claude Code noreply@anthropic.com